home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / man / lib / tk / radiobuttn.man < prev    next >
Encoding:
Text File  |  1992-08-24  |  13.2 KB  |  449 lines
  1. '\"
  2. '\" Copyright 1990 Regents of the University of California
  3. '\" Permission to use, copy, modify, and distribute this
  4. '\" documentation for any purpose and without fee is hereby
  5. '\" granted, provided that this notice appears in all copies.
  6. '\" The University of California makes no representations about
  7. '\" the suitability of this material for any purpose.  It is
  8. '\" provided "as is" without express or implied warranty.
  9. '\" 
  10. '\" $Header: /user6/ouster/wish/man/RCS/radiobuttn.man,v 1.18 92/05/29 14:01:23 ouster Exp $ SPRITE (Berkeley)
  11. '/" 
  12. .\" The definitions below are for supplemental macros used in Sprite
  13. .\" manual entries.
  14. .\"
  15. .\" .HS name section [date [version]]
  16. .\"    Replacement for .TH in other man pages.  See below for valid
  17. .\"    section names.
  18. .\"
  19. .\" .AP type name in/out [indent]
  20. .\"    Start paragraph describing an argument to a library procedure.
  21. .\"    type is type of argument (int, etc.), in/out is either "in", "out",
  22. .\"    or "in/out" to describe whether procedure reads or modifies arg,
  23. .\"    and indent is equivalent to second arg of .IP (shouldn't ever be
  24. .\"    needed;  use .AS below instead)
  25. .\"
  26. .\" .AS [type [name]]
  27. .\"    Give maximum sizes of arguments for setting tab stops.  Type and
  28. .\"    name are examples of largest possible arguments that will be passed
  29. .\"    to .AP later.  If args are omitted, default tab stops are used.
  30. .\"
  31. .\" .BS
  32. .\"    Start box enclosure.  From here until next .BE, everything will be
  33. .\"    enclosed in one large box.
  34. .\"
  35. .\" .BE
  36. .\"    End of box enclosure.
  37. .\"
  38. .\" .VS
  39. .\"    Begin vertical sidebar, for use in marking newly-changed parts
  40. .\"    of man pages.
  41. .\"
  42. .\" .VE
  43. .\"    End of vertical sidebar.
  44. .\"
  45. .\" .DS
  46. .\"    Begin an indented unfilled display.
  47. .\"
  48. .\" .DE
  49. .\"    End of indented unfilled display.
  50. .\"
  51. '\"    # Heading for Sprite man pages
  52. .de HS
  53. .if '\\$2'cmds'       .TH \\$1 1 \\$3 \\$4
  54. .if '\\$2'lib'        .TH \\$1 3 \\$3 \\$4
  55. .if '\\$2'tcl'        .TH \\$1 3 \\$3 \\$4
  56. .if '\\$2'tk'         .TH \\$1 3 \\$3 \\$4
  57. .if t .wh -1.3i ^B
  58. .nr ^l \\n(.l
  59. .ad b
  60. ..
  61. '\"    # Start an argument description
  62. .de AP
  63. .ie !"\\$4"" .TP \\$4
  64. .el \{\
  65. .   ie !"\\$2"" .TP \\n()Cu
  66. .   el          .TP 15
  67. .\}
  68. .ie !"\\$3"" \{\
  69. .ta \\n()Au \\n()Bu
  70. \&\\$1    \\fI\\$2\\fP    (\\$3)
  71. .\".b
  72. .\}
  73. .el \{\
  74. .br
  75. .ie !"\\$2"" \{\
  76. \&\\$1    \\fI\\$2\\fP
  77. .\}
  78. .el \{\
  79. \&\\fI\\$1\\fP
  80. .\}
  81. .\}
  82. ..
  83. '\"    # define tabbing values for .AP
  84. .de AS
  85. .nr )A 10n
  86. .if !"\\$1"" .nr )A \\w'\\$1'u+3n
  87. .nr )B \\n()Au+15n
  88. .\"
  89. .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
  90. .nr )C \\n()Bu+\\w'(in/out)'u+2n
  91. ..
  92. '\"    # BS - start boxed text
  93. '\"    # ^y = starting y location
  94. '\"    # ^b = 1
  95. .de BS
  96. .br
  97. .mk ^y
  98. .nr ^b 1u
  99. .if n .nf
  100. .if n .ti 0
  101. .if n \l'\\n(.lu\(ul'
  102. .if n .fi
  103. ..
  104. '\"    # BE - end boxed text (draw box now)
  105. .de BE
  106. .nf
  107. .ti 0
  108. .mk ^t
  109. .ie n \l'\\n(^lu\(ul'
  110. .el \{\
  111. .\"    Draw four-sided box normally, but don't draw top of
  112. .\"    box if the box started on an earlier page.
  113. .ie !\\n(^b-1 \{\
  114. \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
  115. .\}
  116. .el \}\
  117. \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
  118. .\}
  119. .\}
  120. .fi
  121. .br
  122. .nr ^b 0
  123. ..
  124. '\"    # VS - start vertical sidebar
  125. '\"    # ^Y = starting y location
  126. '\"    # ^v = 1 (for troff;  for nroff this doesn't matter)
  127. .de VS
  128. .mk ^Y
  129. .ie n 'mc \s12\(br\s0
  130. .el .nr ^v 1u
  131. ..
  132. '\"    # VE - end of vertical sidebar
  133. .de VE
  134. .ie n 'mc
  135. .el \{\
  136. .ev 2
  137. .nf
  138. .ti 0
  139. .mk ^t
  140. \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
  141. .sp -1
  142. .fi
  143. .ev
  144. .\}
  145. .nr ^v 0
  146. ..
  147. '\"    # Special macro to handle page bottom:  finish off current
  148. '\"    # box/sidebar if in box/sidebar mode, then invoked standard
  149. '\"    # page bottom macro.
  150. .de ^B
  151. .ev 2
  152. 'ti 0
  153. 'nf
  154. .mk ^t
  155. .if \\n(^b \{\
  156. .\"    Draw three-sided box if this is the box's first page,
  157. .\"    draw two sides but no top otherwise.
  158. .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
  159. .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
  160. .\}
  161. .if \\n(^v \{\
  162. .nr ^x \\n(^tu+1v-\\n(^Yu
  163. \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
  164. .\}
  165. .bp
  166. 'fi
  167. .ev
  168. .if \\n(^b \{\
  169. .mk ^y
  170. .nr ^b 2
  171. .\}
  172. .if \\n(^v \{\
  173. .mk ^Y
  174. .\}
  175. ..
  176. '\"    # DS - begin display
  177. .de DS
  178. .RS
  179. .nf
  180. .sp
  181. ..
  182. '\"    # DE - end display
  183. .de DE
  184. .fi
  185. .RE
  186. .sp .5
  187. ..
  188. .HS radiobutton cmds
  189. .BS
  190. '\" Note:  do not modify the .SH NAME line immediately below!
  191. .SH NAME
  192. radiobutton \- Create and manipulate radio-button widgets
  193. .SH SYNOPSIS
  194. \fBradiobutton\fI \fIpathName \fR?\fIoptions\fR?
  195. .SH "STANDARD OPTIONS"
  196. .LP
  197. .nf
  198. .ta 4c 8c 12c
  199. .VS
  200. \fBactiveBackground\fR    \fBbitmap\fR    \fBfont\fR    \fBrelief\fR
  201. \fBactiveForeground\fR    \fBborderWidth\fR    \fBforeground\fR    \fBtext\fR
  202. \fBanchor\fR    \fBcursor\fR    \fBpadX\fR    \fBtextVariable\fR
  203. \fBbackground\fR    \fBdisabledForeground\fR    \fBpadX\fR
  204. .VE
  205. .fi
  206. .LP
  207. See the ``options'' manual entry for details on the standard options.
  208. .SH "WIDGET-SPECIFIC OPTIONS"
  209. .ta 4c
  210. .LP
  211. .nf
  212. Name:    \fBcommand\fR
  213. Class:    \fBCommand\fR
  214. Command-Line Switch:    \fB\-command\fR
  215. .fi
  216. .IP
  217. Specifies a Tcl command to associate with the button.  This command
  218. is typically invoked when mouse button 1 is released over the button
  219. window.
  220. .LP
  221. .nf
  222. .VS
  223. Name:    \fBheight\fR
  224. Class:    \fBHeight\fR
  225. Command-Line Switch:    \fB\-height\fR
  226. .fi
  227. .IP
  228. Specifies a desired height for the button.
  229. If a bitmap is being displayed in the button then the value is in
  230. screen units (i.e. any of the forms acceptable to \fBTk_GetPixels\fR);
  231. for text it is in lines of text.
  232. If this option isn't specified, the button's desired height is computed
  233. from the size of the bitmap or text being displayed in it.
  234. .VE
  235. .LP
  236. .nf
  237. Name:    \fBselector\fR
  238. Class:    \fBForeground\fR
  239. Command-Line Switch:    \fB\-selector\fR
  240. .fi
  241. .IP
  242. Specifies the color to draw in the selector when this button is
  243. selected.
  244. .VS
  245. If specified as an empty string then no selector is drawn for the button.
  246. .LP
  247. .nf
  248. Name:    \fBstate\fR
  249. Class:    \fBState\fR
  250. Command-Line Switch:    \fB\-state\fR
  251. .fi
  252. .IP
  253. Specifies one of three states for the radio button:  \fBnormal\fR, \fBactive\fR,
  254. or \fBdisabled\fR.  In normal state the radio button is displayed using the
  255. \fBforeground\fR and \fBbackground\fR options.  The active state is
  256. typically used when the pointer is over the radio button.  In active state
  257. the radio button is displayed using the \fBactiveForeground\fR and
  258. \fBactiveBackground\fR options.  Disabled state means that the radio button
  259. is insensitive:  it doesn't activate and doesn't respond to mouse
  260. button presses.  In this state the \fBdisabledForeground\fR and
  261. \fBbackground\fR options determine how the radio button is displayed.
  262. .VE
  263. .LP
  264. .nf
  265. Name:    \fBvalue\fR
  266. Class:    \fBValue\fR
  267. Command-Line Switch:    \fB\-value\fR
  268. .fi
  269. .IP
  270. Specifies value to store in the button's associated variable whenever
  271. this button is selected.  Defaults to the name of the radio button.
  272. .LP
  273. .nf
  274. Name:    \fBvariable\fR
  275. Class:    \fBVariable\fR
  276. Command-Line Switch:    \fB\-variable\fR
  277. .fi
  278. .IP
  279. Specifies name of global variable to set whenever this button is
  280. selected.  Changes in this variable also cause the button to select
  281. or deselect itself.
  282. Defaults to the value \fBselectedButton\fR.
  283. .LP
  284. .nf
  285. .VS
  286. Name:    \fBwidth\fR
  287. Class:    \fBWidth\fR
  288. Command-Line Switch:    \fB\-width\fR
  289. .fi
  290. .IP
  291. Specifies a desired width for the button.
  292. If a bitmap is being displayed in the button then the value is in
  293. screen units (i.e. any of the forms acceptable to \fBTk_GetPixels\fR);
  294. for text it is in characters.
  295. If this option isn't specified, the button's desired width is computed
  296. from the size of the bitmap or text being displayed in it.
  297. .VE
  298. .BE
  299.  
  300. .SH DESCRIPTION
  301. .PP
  302. The \fBradiobutton\fR command creates a new window (given by the
  303. \fIpathName\fR argument) and makes it into a radiobutton widget.
  304. Additional
  305. options, described above, may be specified on the command line
  306. or in the option database
  307. to configure aspects of the radio button such as its colors, font,
  308. text, and initial relief.  The \fBradiobutton\fR command returns its
  309. \fIpathName\fR argument.  At the time this command is invoked,
  310. there must not exist a window named \fIpathName\fR, but
  311. \fIpathName\fR's parent must exist.
  312. .PP
  313. A radio button is a widget
  314. .VS
  315. that displays a textual string or bitmap
  316. and a diamond called a \fIselector\fR.
  317. A radio button has
  318. all of the behavior of a simple button: it can display itself in either
  319. of three different ways, according to the \fBstate\fR option;
  320. .VE
  321. it can be made to appear
  322. raised, sunken, or flat; it can be made to flash; and it invokes
  323. a Tcl command whenever mouse button 1 is clicked over the
  324. check button.
  325. .PP
  326. In addition, radio buttons can be \fIselected\fR.
  327. If a radio button is selected then a special highlight appears
  328. in the selector and a Tcl variable associated with the radio button
  329. is set to a particular value.
  330. If the radio button is not selected then the selector is drawn
  331. in a different fashion.
  332. Typically, several radio buttons share a single variable and the
  333. value of the variable indicates which radio button is to be selected.
  334. .VS
  335. When a radio button is selected it sets the value of the variable to
  336. indicate that fact;  each radio button also monitors the value of
  337. the variable and automatically selects and deselects itself when the
  338. variable's value changes.
  339. .VE
  340. By default the variable \fBselectedButton\fR
  341. is used;  its contents give the name of the button that is
  342. selected, or the empty string if no button associated with that
  343. variable is selected.
  344. The name of the variable for a radio button,
  345. plus the variable to be stored into it, may be modified with options
  346. on the command line or in the option database.  By default a radio
  347. button is configured to select itself on button clicks.
  348.  
  349. .SH "WIDGET COMMAND"
  350. .PP
  351. The \fBradiobutton\fR command creates a new Tcl command whose
  352. name is \fIpathName\fR.  This
  353. command may be used to invoke various
  354. operations on the widget.  It has the following general form:
  355. .DS C
  356. \fIpathName option \fR?\fIarg arg ...\fR?
  357. .DE
  358. \fIOption\fR and the \fIarg\fRs
  359. determine the exact behavior of the command.  The following
  360. commands are possible for radio-button widgets:
  361. .TP
  362. \fIpathName \fBactivate\fR
  363. Change the radio button's state to \fBactive\fR and redisplay the button
  364. using its active foreground and background colors instead of normal
  365. colors.
  366. .VS
  367. This command is ignored if the radio button's state is \fBdisabled\fR.
  368. This command is obsolete and will eventually be removed;
  369. use ``\fIpathName \fBconfigure \-state active\fR'' instead.
  370. .TP
  371. \fIpathName \fBconfigure\fR ?\fIoption\fR? ?\fIvalue option value ...\fR?
  372. Query or modify the configuration options of the widget.
  373. If no \fIoption\fR is specified, returns a list describing all of
  374. the available options for \fIpathName\fR (see \fBTk_ConfigureInfo\fR for
  375. information on the format of this list).  If \fIoption\fR is specified
  376. with no \fIvalue\fR, then the command returns a list describing the
  377. one named option (this list will be identical to the corresponding
  378. sublist of the value returned if no \fIoption\fR is specified).  If
  379. one or more \fIoption\-value\fR pairs are specified, then the command
  380. modifies the given widget option(s) to have the given value(s);  in
  381. this case the command returns an empty string.
  382. \fIOption\fR may have any of the values accepted by the \fBradiobutton\fR
  383. command.
  384. .TP
  385. \fIpathName \fBdeactivate\fR
  386. Change the radio button's state to \fBnormal\fR and redisplay the button
  387. using its normal foreground and background colors.
  388. .VS
  389. This command is ignored if the radio button's state is \fBdisabled\fR.
  390. This command is obsolete and will eventually be removed;
  391. use ``\fIpathName \fBconfigure \-state normal\fR'' instead.
  392. .VE
  393. .TP
  394. \fIpathName \fBdeselect\fR
  395. Deselect the radio button:  redisplay it without a highlight in
  396. the selector and set the associated variable to an empty string.  If
  397. this radio button was not currently selected, then the command has
  398. no effect.
  399. .TP
  400. \fIpathName \fBflash\fR
  401. Flash the radio button.  This is accomplished by redisplaying the radio button
  402. several times, alternating between active and normal colors.  At
  403. the end of the flash the radio button is left in the same normal/active
  404. state as when the command was invoked.
  405. .VS
  406. This command is ignored if the radio button's state is \fBdisabled\fR.
  407. .VE
  408. .TP
  409. \fIpathName \fBinvoke\fR
  410. .VS
  411. Does just what would have happened if the user invoked the radio button
  412. with the mouse: select the button and invoke
  413. its associated Tcl command, if there is one.
  414. The return value is the return value from the Tcl command, or an
  415. empty string if there is no command associated with the radio button.
  416. This command is ignored if the radio button's state is \fBdisabled\fR.
  417. .VE
  418. .TP
  419. \fIpathName \fBselect\fR
  420. Select the radio button:  display it with a highlighted
  421. selector and set the associated variable to the value corresponding
  422. to this widget.
  423.  
  424. .SH BINDINGS
  425. .PP
  426. .VS
  427. Tk automatically creates class bindings for radio buttons that give them
  428. the following default behavior:
  429. .IP [1]
  430. The radio button activates whenever the mouse passes over it and deactivates
  431. whenever the mouse leaves the radio button.
  432. .IP [2]
  433. The radio button's relief is changed to sunken whenever mouse button 1 is
  434. pressed over it, and the relief is restored to its original
  435. value when button 1 is later released.
  436. .IP [3]
  437. If mouse button 1 is pressed over the radio button and later released over
  438. the radio button, the radio button is invoked (i.e. it is selected
  439. and the command associated with the button is invoked,
  440. if there is one).  However, if the mouse is not
  441. over the radio button when button 1 is released, then no invocation occurs.
  442. .PP
  443. The behavior of radio buttons can be changed by defining new bindings for
  444. individual widgets or by redefining the class bindings.
  445. .VE
  446.  
  447. .SH KEYWORDS
  448. radio button, widget
  449.